/**
 * \file Error.h
 * \brief error definition enum.
 * \author Edouard ROGE
 * \date 08 august 2012
 */

#ifndef _ERROR_
#define _ERROR_

/** Core functions and classes for Thread, memory, logger... etc */
namespace Core
{
	/**
	* \enum error
	* list all the kind of errors we can find
	*/
	enum error
	{
		/** OK */
		errOK = 0,
		/** Failed, unknown reason*/
		errFailed,
		/** Failed, insufficient memory*/
		errInsufficientMemory,
	};

	/**
	* \fn bool Failed(error e);
	* \param e error to test
	* \return true if the parameter error is errFailed
	* \brief check if the error is OK or Failed
	*/
	bool Failed(error e);

	/**
	* \fn bool Succeeded(error e);
	* \param e error to test
	* \return true if the parameter error is errOK
	* \brief check if the error is OK or Failed
	*/
	bool Succeeded(error e);
}

#endif // _ERROR_
